Node / meshtastic / Meshtastic-Android / files / specs / 20260507-161858-app-docs-markdown / checklists / requirements.md

Displaying Rendered • View raw • Download

Purpose: Validate the Android/KMP-adapted spec before implementation begins

Created: 2026-05-07

Feature: spec.md

• [x] Scope is clear: web docs, in-app docs, search, AI fallback, and automation are explicitly bounded.

• [x] The spec is adapted to Meshtastic-Android architecture (KMP, Navigation 3, Koin, Gradle, flavors).

• [x] User-facing outcomes are described separately from implementation mechanics.

• [x] Platform-specific behavior differences (Android vs Desktop/iOS vs flavor gating) are explicitly called out.

• [x] No placeholder sections or unresolved TODO markers remain.

• [x] Functional requirements cover docs authoring, rendering, packaging, routing, AI, screenshots, and CI automation.

• [x] Requirements include measurable constraints for performance, accessibility, bundle size, and release versioning.

• [x] Edge cases cover missing assets, unsupported AI environments, stale deep links, and degraded screenshot automation.

• [x] The deep-link contract, keyword-index schema, and CI workflow contract are defined as separate artifacts.

• [x] Search and AI fallback behavior are specified for unsupported targets and flavors.

• [x] Screenshot asset bundling and inline rendering via custom T383838ImageTransformer are specified (FR-038).

• [x] WebView plus cross-platform renderer abstraction is specified for in-app rendering.

• [x] Gemini Nano / AICore / ML Kit GenAI expectations and explicit fallbacks are defined.

• [x] Gradle-generated resources/assets are used for bundling.

• [x] Navigation 3 typed routes are used throughout.

• [x] Guidance is derived from existing UI copy, warnings, and callouts for in-app tips.

• [x] T383838MeshtasticIcons and vector assets are used for all iconography.

• [x] T383838feature/docs/ module placement and plugin usage are specified.

• [x] Docs content sources reference actual Meshtastic-Android modules and file paths.

• [x] The plan and tasks phases align with the requested Phase 0–8 breakdown.

• [x] The spec is ready for implementation planning and execution without further clarification.

• Some technical detail remains intentionally explicit because this is a platform-adaptation spec, not a product-only brief.

• The AI path is intentionally flavor- and runtime-gated so the spec remains compatible with both T383838google and T383838fdroid builds.

• Screenshot automation is specified with a preferred path (Roborazzi) and an acceptable alternative (Paparazzi) because the repository has no active screenshot framework today.